home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 18 / CU Amiga Magazine's Super CD-ROM 18 (1997)(EMAP Images)(GB)[!][issue 1998-01].iso / CUCD / Online / hsc / docs-source / project / hscpitt.hsc < prev    next >
Encoding:
Text File  |  1997-10-14  |  6.7 KB  |  201 lines
  1. <WEBPAGE chapter="hsc - Project Management - " title="Hscpitt"
  2.     BACK="index.html"
  3.     PREV="prjfile.html"
  4.     NEXT="make.html">
  5.  
  6. <*
  7. ** macro to format an explanation
  8. *>
  9. <$MACRO explan TITLE:string/r NAME:string>
  10. <** create named reference **>
  11. <DT>
  12. <$stripws>
  13. <$IF COND=(SET NAME)>
  14.     <A NAME=(Name)>
  15. <$ELSE>
  16.     <A NAME=(Title)>
  17. </$IF>
  18. <$stripws>
  19. <KBD><(Title)></KBD></A>
  20. <DD>
  21. </$MACRO>
  22.  
  23. <*** render heading and link for pitt-command ***>
  24. <$macro pittCmd NAME:string/required>
  25. <H3><A NAME=(Name)><(Name)></A></H3>
  26. </$macro>
  27.  
  28. <$macro pittCmdNote NAME:string/required NOTE:string/required>
  29. <A HREF=("#"+Name)><KBD><(Name)></KBD></A> - <(Note)>
  30. </$macro>
  31.  
  32. <STRONG>hsc Project Interfering And Trashing Tool</STRONG>
  33.  
  34. <P><hscpitt CAP> can be used to extract and manipulate data stored
  35. in <hsc>'s project file. It lists all documents stored in the
  36. project and removes entries and corresponding files for
  37. documents.</P>
  38.  
  39. <P><hscpitt CAP> is part of the hsc-distribution and therefor the
  40. same legal issues apply.</P>
  41.  
  42. <hscpitt CAP> is dedicated to Brad Pitt.
  43.  
  44. <P><STRONG>Important</STRONG>: <hscpitt> should be used with caution.
  45. It assumes that the user knows what he is doing and does <EM>not</EM>
  46. ask back before performing any action. Using <hscpitt> it is rather
  47. easy to remove information within seconds that required hours
  48. being implemented.</P>
  49.  
  50. <H2>Options And Switches</H2>
  51.  
  52. <DL>
  53. <EXPLAN TITLE="HELP=-h=?/S">
  54. Display short help message and exit.
  55.  
  56. <EXPLAN TITLE="LICENSE/S">    
  57. Display a short version of <A HREF=":copy.html">Copyright</A>
  58. and exit.
  59.  
  60. <EXPLAN TITLE="COMMAND" NAME="command">
  61. Command to be applied to project. Supported commands are:
  62. <UL>
  63. <*<LI><pittCmdNote NAME="INFO" NOTE="show general info about project">*>
  64. <LI><pittCmdNote NAME="NEW" NOTE="create new project">
  65. <LI><pittCmdNote NAME="LIST" NOTE="show list of documents">
  66. <LI><pittCmdNote NAME="ADD" NOTE="add new document to project">
  67. <LI><pittCmdNote NAME="DELETE"
  68.                  NOTE=("remove documents entries from project, "
  69.                       +"but leave corresponding files intact")>
  70. <LI><pittCmdNote NAME="ERASE"
  71.                  NOTE=("remove documents entries from project and"
  72.                       +"also corresponding document and source file.")>
  73. <LI><pittCmdNote NAME="EXTRACT"
  74.                 NOTE=("show detailed list of all documents "
  75.                      +"currently stored in project")>
  76. </UL>
  77.  
  78. For a more detailed explanation of these commands see below.
  79.  
  80. <EXPLAN TITLE="ARG/M">
  81. Arguments for command. Depends on the value of <KBD>COMMAND</KBD>.
  82.  
  83. <EXPLAN TITLE="PRJFILE/K" NAME="prjfile">
  84. Specifies project file to be examined/manipulated. If
  85. none given, <FILE>hsc.project</FILE> is used.
  86.  
  87. <EXPLAN TITLE="QUIET/S">
  88. Act quietly, do not display progress and status messages.
  89.  
  90. <EXPLAN TITLE="FORCE/S">
  91. Certain commands refuse to overwrite already existing data.
  92. Nevertheless with this switch enabled the will.
  93.  
  94. <EXPLAN TITLE="-DEBUG/S">
  95. Enable debug mode; only useful if compiled in debug mode.
  96. </DL>
  97.  
  98. <H2>Commands</H2>
  99.  
  100. <pittCmd NAME="NEW">
  101. This command will create a new project file containing no documents.
  102. If the project file already exists, this command will refuse to
  103. overwrite it. You have to enable the switch <KBD>FORCE</KBD> to
  104. accomplish this.
  105.  
  106. <pittCmd NAME="COUNT">
  107. Setting <KBD>COMMAND=COUNT</KBD> will output the number of
  108. documents currently stored in the project file.
  109.  
  110. <pittCmd NAME="LIST">
  111. <P>Setting <KBD>COMMAND=LIST</KBD> will output a short
  112. list of documents to <stdout>. Every line contains the
  113. name of a html-object.
  114.  
  115. <pittCmd NAME="ADD">
  116.  
  117. <P>Setting <KBD>COMMAND=ADD</KBD> will add a new document with it's
  118. corresponding main source to the project. The first <KBD>ARG</KBD>
  119. contains the <EM>full</EM> relative filename of the html-object, the
  120. second <KBD>ARG</KBD> contains the name of the main hsc-source that
  121. will be used to create the document.</P>
  122.  
  123. If the document already is part of the project, an error message will
  124. be displayed and the old document will be left untouched. To replace a
  125. document, you will have to enable the switch <KBD>FORCE</KBD> before.
  126.  
  127. <pittCmd NAME="DELETE">
  128. Setting <KBD>COMMAND=DELETE</KBD> will remove the entries
  129. specified in <KBD>ARG</KBD> from the project file. The document
  130. and the corresponding source remains untouched.
  131.  
  132. <pittCmd NAME="ERASE">
  133. Setting <KBD>COMMAND=ERASE</KBD> will remove the entries
  134. specified in <KBD>ARG</KBD> from the project file. Different to
  135. <KBD>COMMAND=DELETE</KBD>, it will also <EM>remove</EM>
  136. the files for document and source. This command should be used
  137. with caution.
  138.  
  139. <pittCmd NAME="EXTRACT">
  140. <P>Setting <KBD>COMMAND=EXTRACT</KBD> will output a detailed
  141. list of documents to <stdout>. This command is mend to be used
  142. if you want to utilize the information stored in the project 
  143. file. Just redirect the output of <hscpitt> and scan it by
  144. your program.</P>
  145.  
  146. <P>All lines match the template
  147. <BLOCKQUOTE>
  148.     <I>identifier</I><CODE>="</CODE><I>value</I><CODE>"</CODE>
  149. </BLOCKQUOTE>
  150. You <STRONG>must not</STRONG> make any assumptions about the
  151. sequence of identifiers. Your program should be able
  152. to skip unknown identifiers. At the end of data about a
  153. document, an <CODE>EOF</CODE> occurs or an empty line with
  154. another document succeeding.
  155.  
  156. <P>Currently, possible identifers are:
  157. <DL>
  158. <DT><CODE>DOCUMENT</CODE>
  159. <DD>URI of document, relative to current directory
  160. <DT><CODE>SOURCE</CODE>
  161. <DD>Filename of main source file used to create document, 
  162.     relative to current directory
  163. <DT><CODE>INCLUDE</CODE>
  164. <DD>Name of a file that has been included during processing
  165.     the document. This identifier can show up more then once,
  166.     if multiple files have been included.
  167. </DL>
  168.  
  169. See also <A HREF="hscpaltrow.html"><hscpaltrow></A>
  170. to learn how you can utilize this command.
  171.  
  172. <H2>Examples</H2>
  173. <DL>
  174. <DT><KBD>hscpitt HELP</KBD>
  175. <DD>Displays help and exits.
  176.  
  177. <DT><KBD>hscpitt PRJFILE=sepp.project COMMAND=NEW</KBD>
  178. <DD>Create a new project and store data in <FILE>sepp.project</FILE>.
  179.  
  180. <DT><KBD>hscpitt PRJFILE=sepp.project LIST</KBD>
  181. <DD>List all documents currently stored in project file 
  182.     <FILE>sepp.project</FILE>.
  183.  
  184. <DT><KBD>hscpitt ADD ../docs/sepp.html sepp.hsc</KBD>
  185. <DD>Adds document <FILE>sepp.html</FILE>, which is created from
  186. <FILE>sepp.hsc</FILE>. Note that <FILE>../docs/</FILE> denotes the
  187. relative path, where the html-objects are located. This usually is
  188. the same value you used as <qqc>TO</qqc> argument to invoke <hsc>.
  189.  
  190. <DT><KBD>hscpitt EXTRACT</KBD>
  191. <DD>List information about all documents currently stored in project file 
  192.     <FILE>hsc.project</FILE>. 
  193.  
  194. <DT><KBD>hscpitt COMMAND=DELETE www:index.html www:sepp/hugo.html</KBD>
  195. <DD>Remove entries for the documents <FILE>www:index.html</FILE> and 
  196.     <FILE>www:sepp/hugo.html</FILE> from the project file. The html-object
  197.     and hsc-sources for these documents will not be removed.
  198. </DL>
  199.  
  200. </WEBPAGE>
  201.